home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / MrmOpenHierarchy.z / MrmOpenHierarchy
Encoding:
Text File  |  2001-04-17  |  16.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy - Allocates a hierarchy ID and opens all
  10.           the UID files in the hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Mrm/MrmPublic.h>
  14.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy(
  15.           MMMMrrrrmmmmCCCCoooouuuunnnntttt nnnnuuuummmm____ffffiiiilllleeeessss,
  16.           SSSSttttrrrriiiinnnngggg ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt[],
  17.           MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr ****aaaannnncccciiiillllllllaaaarrrryyyy____ssssttttrrrruuuuccccttttuuuurrrreeeessss____lllliiiisssstttt,
  18.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy ****hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd);
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           This routine is obsolete and exists for compatibility with
  25.           previous releases. It is replaced by
  26.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.  MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy is identical
  27.           to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyyexcept that MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy
  28.           does not take a _d_i_s_p_l_a_yargument.
  29.  
  30.           _n_u_m__f_i_l_e_s Specifies the number of files in the name list.
  31.  
  32.           _f_i_l_e__n_a_m_e_s__l_i_s_t
  33.                     Specifies an array of character strings that
  34.                     identify the UID files.
  35.  
  36.           _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t
  37.                     A list of operating-system-dependent ancillary
  38.                     structures corresponding to items such as
  39.                     filenames, clobber flags, and so forth.  This
  40.                     argument should be NULL for most operations.  If
  41.                     you need to reference this structure, see the
  42.                     definition of MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrrin the MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh
  43.                     header file for more information.
  44.  
  45.           _h_i_e_r_a_r_c_h_y__i_d
  46.                     Returns the search hierarchy ID.  The search
  47.                     hierarchy ID identifies the list of UID files that
  48.                     MRM searches (in order) when performing subsequent
  49.                     fetch calls.
  50.  
  51.           Each UID file string in _f_i_l_e__n_a_m_e_s__l_i_s_t can specify either a
  52.           full pathname or a filename.  If a UID file string has a
  53.           leading slash (/), it specifies a full pathname, and MRM
  54.           opens the file as specified.  Otherwise, the UID file string
  55.           specifies a filename.  In this case, MRM looks for the file
  56.           along a search path specified by the UUUUIIIIDDDDPPPPAAAATTTTHHHH environment
  57.           variable or by a default search path, which varies depending
  58.           on whether or not the XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR environment variable is
  59.           set.
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           The UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable specifies a search path and
  75.           naming conventions associated with UID files.  It can
  76.           contain the substitution field %%%%UUUU, where the UID file string
  77.           from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to
  78.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy is substituted for %%%%UUUU.  It can
  79.           also contain the substitution fields accepted by
  80.           XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee.  The substitution field %%%%TTTT is always
  81.           mapped to _u_i_d.  The entire path is first searched with %%%%SSSS
  82.           mapped to ....uuuuiiiidddd.  If no file is found, it is searched again
  83.           with %%%%SSSS mapped to NULL.
  84.  
  85.           If no display is set prior to calling this function, the
  86.           result of this function's call to XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee is
  87.           undefined.
  88.  
  89.           For example, the following UUUUIIIIDDDDPPPPAAAATTTTHHHH value and
  90.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy call cause MRM to open two separate UID
  91.           files:
  92.  
  93.           UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L
  94.             static char *uid_files[] = {"/usr/users/me/test.uid", "test2"};
  95.             MrmHierarchy  *Hierarchy_id;
  96.             MrmOpenHierarchy((MrmCount)2,uid_files, NULL, Hierarchy_id)
  97.  
  98.           MRM opens the first file, ////uuuussssrrrr////uuuusssseeeerrrrssss////mmmmeeee////tttteeeesssstttt....uuuuiiiidddd, as
  99.           specified in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to
  100.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy, because the UID file string in the
  101.           _f_i_l_e__n_a_m_e_s__l_i_s_t argument specifies a full pathname.  MRM
  102.           looks for the second file, tttteeeesssstttt2222, first as
  103.           ////uuuuiiiiddddlllliiiibbbb////%%%%LLLL////tttteeeesssstttt2222....uuuuiiiiddddand second as ////uuuuiiiiddddlllliiiibbbb////tttteeeesssstttt2222////%%%%LLLL, where
  104.           the display's language string is substituted for %%%%LLLL.
  105.  
  106.           After MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyopens the UID hierarchy, you should
  107.           not delete or modify the UID files until you close the UID
  108.           hierarchy by calling MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy.
  109.  
  110.           If UUUUIIIIDDDDPPPPAAAATTTTHHHH is not set but the environment variable
  111.           XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames:
  112.  
  113.              +o  %%%%UUUU%%%%SSSS
  114.  
  115.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  116.  
  117.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  118.  
  119.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  120.  
  121.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  122.  
  123.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  124.  
  125.              +o  $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  137.  
  138.  
  139.  
  140.              +o  $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  141.  
  142.              +o  $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS
  143.  
  144.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  145.  
  146.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  147.  
  148.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  149.  
  150.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  151.  
  152.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  153.  
  154.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  155.  
  156.              +o  ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  157.  
  158.           If neither UUUUIIIIDDDDPPPPAAAATTTTHHHH nor XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the
  159.           following pathnames:
  160.  
  161.              +o  %%%%UUUU%%%%SSSS
  162.  
  163.              +o  HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  164.  
  165.              +o  HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  166.  
  167.              +o  $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  168.  
  169.              +o  $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  170.  
  171.              +o  $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  172.  
  173.              +o  $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  174.  
  175.              +o  $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS
  176.  
  177.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  178.  
  179.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  180.  
  181.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  182.  
  183.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  184.  
  185.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  186.  
  187.              +o  ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  188.  
  189.              +o  ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  190.  
  191.           These paths are defaults that vendors may change.  For
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 4/6/01)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           example, a vendor may use different directories for
  207.           ////uuuussssrrrr////lllliiiibbbb////XXXX11111111 and ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111.
  208.  
  209.           The following substitutions are used in these paths:
  210.  
  211.           %%%%UUUU        The UID file string, from the _f_i_l_e__n_a_m_e_s__l_i_s_t
  212.                     argument.
  213.  
  214.           %%%%NNNN        The class name of the application.
  215.  
  216.           %%%%LLLL        The display's language string.  This string is
  217.                     influenced by XXXXttttSSSSeeeettttLLLLaaaannnngggguuuuaaaaggggeeeePPPPrrrroooocccc.  The default
  218.                     string is determined by calling setlocale(_L_C__A_L_L,
  219.                     _N_U_L_L).
  220.  
  221.           %%%%llll        The language component of the display's language
  222.                     string.
  223.  
  224.           %%%%SSSS        The suffix to the filename.  The entire path is
  225.                     first searched with a suffix of ....uuuuiiiidddd.  If no file
  226.                     is found, it is searched again with a NULL suffix.
  227.  
  228.      RRRREEEETTTTUUUURRRRNNNN
  229.           This function returns one of the following status return
  230.           constants:
  231.  
  232.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  233.                     The function executed successfully.
  234.  
  235.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD
  236.                     File not found.
  237.  
  238.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  239.                     The function failed.
  240.  
  241.      RRRREEEELLLLAAAATTTTEEEEDDDD
  242.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy(3) and MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy(3).
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 4/6/01)
  262.  
  263.  
  264.  
  265.